home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / share / perl5 / LWP / UserAgent.pm < prev   
Text File  |  2009-07-07  |  53KB  |  1,680 lines

  1. package LWP::UserAgent;
  2.  
  3. use strict;
  4. use vars qw(@ISA $VERSION);
  5.  
  6. require LWP::MemberMixin;
  7. @ISA = qw(LWP::MemberMixin);
  8. $VERSION = "5.829";
  9.  
  10. use HTTP::Request ();
  11. use HTTP::Response ();
  12. use HTTP::Date ();
  13.  
  14. use LWP ();
  15. use LWP::Protocol ();
  16.  
  17. use Carp ();
  18.  
  19. if ($ENV{PERL_LWP_USE_HTTP_10}) {
  20.     require LWP::Protocol::http10;
  21.     LWP::Protocol::implementor('http', 'LWP::Protocol::http10');
  22.     eval {
  23.         require LWP::Protocol::https10;
  24.         LWP::Protocol::implementor('https', 'LWP::Protocol::https10');
  25.     };
  26. }
  27.  
  28.  
  29.  
  30. sub new
  31. {
  32.     # Check for common user mistake
  33.     Carp::croak("Options to LWP::UserAgent should be key/value pairs, not hash reference") 
  34.         if ref($_[1]) eq 'HASH'; 
  35.  
  36.     my($class, %cnf) = @_;
  37.  
  38.     my $agent = delete $cnf{agent};
  39.     my $from  = delete $cnf{from};
  40.     my $def_headers = delete $cnf{default_headers};
  41.     my $timeout = delete $cnf{timeout};
  42.     $timeout = 3*60 unless defined $timeout;
  43.     my $use_eval = delete $cnf{use_eval};
  44.     $use_eval = 1 unless defined $use_eval;
  45.     my $parse_head = delete $cnf{parse_head};
  46.     $parse_head = 1 unless defined $parse_head;
  47.     my $show_progress = delete $cnf{show_progress};
  48.     my $max_size = delete $cnf{max_size};
  49.     my $max_redirect = delete $cnf{max_redirect};
  50.     $max_redirect = 7 unless defined $max_redirect;
  51.     my $env_proxy = delete $cnf{env_proxy};
  52.  
  53.     my $cookie_jar = delete $cnf{cookie_jar};
  54.     my $conn_cache = delete $cnf{conn_cache};
  55.     my $keep_alive = delete $cnf{keep_alive};
  56.     
  57.     Carp::croak("Can't mix conn_cache and keep_alive")
  58.       if $conn_cache && $keep_alive;
  59.  
  60.  
  61.     my $protocols_allowed   = delete $cnf{protocols_allowed};
  62.     my $protocols_forbidden = delete $cnf{protocols_forbidden};
  63.     
  64.     my $requests_redirectable = delete $cnf{requests_redirectable};
  65.     $requests_redirectable = ['GET', 'HEAD']
  66.       unless defined $requests_redirectable;
  67.  
  68.     # Actually ""s are just as good as 0's, but for concision we'll just say:
  69.     Carp::croak("protocols_allowed has to be an arrayref or 0, not \"$protocols_allowed\"!")
  70.       if $protocols_allowed and ref($protocols_allowed) ne 'ARRAY';
  71.     Carp::croak("protocols_forbidden has to be an arrayref or 0, not \"$protocols_forbidden\"!")
  72.       if $protocols_forbidden and ref($protocols_forbidden) ne 'ARRAY';
  73.     Carp::croak("requests_redirectable has to be an arrayref or 0, not \"$requests_redirectable\"!")
  74.       if $requests_redirectable and ref($requests_redirectable) ne 'ARRAY';
  75.  
  76.  
  77.     if (%cnf && $^W) {
  78.     Carp::carp("Unrecognized LWP::UserAgent options: @{[sort keys %cnf]}");
  79.     }
  80.  
  81.     my $self = bless {
  82.               def_headers  => $def_headers,
  83.               timeout      => $timeout,
  84.               use_eval     => $use_eval,
  85.                       show_progress=> $show_progress,
  86.               max_size     => $max_size,
  87.               max_redirect => $max_redirect,
  88.                       proxy        => {},
  89.               no_proxy     => [],
  90.                       protocols_allowed     => $protocols_allowed,
  91.                       protocols_forbidden   => $protocols_forbidden,
  92.                       requests_redirectable => $requests_redirectable,
  93.              }, $class;
  94.  
  95.     $self->agent($agent || $class->_agent);
  96.     $self->from($from) if $from;
  97.     $self->cookie_jar($cookie_jar) if $cookie_jar;
  98.     $self->parse_head($parse_head);
  99.     $self->env_proxy if $env_proxy;
  100.  
  101.     $self->protocols_allowed(  $protocols_allowed  ) if $protocols_allowed;
  102.     $self->protocols_forbidden($protocols_forbidden) if $protocols_forbidden;
  103.  
  104.     if ($keep_alive) {
  105.     $conn_cache ||= { total_capacity => $keep_alive };
  106.     }
  107.     $self->conn_cache($conn_cache) if $conn_cache;
  108.  
  109.     return $self;
  110. }
  111.  
  112.  
  113. sub send_request
  114. {
  115.     my($self, $request, $arg, $size) = @_;
  116.     my($method, $url) = ($request->method, $request->uri);
  117.     my $scheme = $url->scheme;
  118.  
  119.     local($SIG{__DIE__});  # protect against user defined die handlers
  120.  
  121.     $self->progress("begin", $request);
  122.  
  123.     my $response = $self->run_handlers("request_send", $request);
  124.  
  125.     unless ($response) {
  126.         my $protocol;
  127.  
  128.         {
  129.             # Honor object-specific restrictions by forcing protocol objects
  130.             #  into class LWP::Protocol::nogo.
  131.             my $x;
  132.             if($x = $self->protocols_allowed) {
  133.                 if (grep lc($_) eq $scheme, @$x) {
  134.                 }
  135.                 else {
  136.                     require LWP::Protocol::nogo;
  137.                     $protocol = LWP::Protocol::nogo->new;
  138.                 }
  139.             }
  140.             elsif ($x = $self->protocols_forbidden) {
  141.                 if(grep lc($_) eq $scheme, @$x) {
  142.                     require LWP::Protocol::nogo;
  143.                     $protocol = LWP::Protocol::nogo->new;
  144.                 }
  145.             }
  146.             # else fall thru and create the protocol object normally
  147.         }
  148.  
  149.         # Locate protocol to use
  150.         my $proxy = $request->{proxy};
  151.         if ($proxy) {
  152.             $scheme = $proxy->scheme;
  153.         }
  154.  
  155.         unless ($protocol) {
  156.             $protocol = eval { LWP::Protocol::create($scheme, $self) };
  157.             if ($@) {
  158.                 $@ =~ s/ at .* line \d+.*//s;  # remove file/line number
  159.                 $response =  _new_response($request, &HTTP::Status::RC_NOT_IMPLEMENTED, $@);
  160.                 if ($scheme eq "https") {
  161.                     $response->message($response->message . " (Crypt::SSLeay or IO::Socket::SSL not installed)");
  162.                     $response->content_type("text/plain");
  163.                     $response->content(<<EOT);
  164. LWP will support https URLs if either Crypt::SSLeay or IO::Socket::SSL
  165. is installed. More information at
  166. <http://search.cpan.org/dist/libwww-perl/README.SSL>.
  167. EOT
  168.                 }
  169.             }
  170.         }
  171.  
  172.         if (!$response && $self->{use_eval}) {
  173.             # we eval, and turn dies into responses below
  174.             eval {
  175.                 $response = $protocol->request($request, $proxy,
  176.                                                $arg, $size, $self->{timeout});
  177.             };
  178.             if ($@) {
  179.                 $@ =~ s/ at .* line \d+.*//s;  # remove file/line number
  180.                     $response = _new_response($request,
  181.                                               &HTTP::Status::RC_INTERNAL_SERVER_ERROR,
  182.                                               $@);
  183.             }
  184.         }
  185.         elsif (!$response) {
  186.             $response = $protocol->request($request, $proxy,
  187.                                            $arg, $size, $self->{timeout});
  188.             # XXX: Should we die unless $response->is_success ???
  189.         }
  190.     }
  191.  
  192.     $response->request($request);  # record request for reference
  193.     $response->header("Client-Date" => HTTP::Date::time2str(time));
  194.  
  195.     $self->run_handlers("response_done", $response);
  196.  
  197.     $self->progress("end", $response);
  198.     return $response;
  199. }
  200.  
  201.  
  202. sub prepare_request
  203. {
  204.     my($self, $request) = @_;
  205.     die "Method missing" unless $request->method;
  206.     my $url = $request->uri;
  207.     die "URL missing" unless $url;
  208.     die "URL must be absolute" unless $url->scheme;
  209.  
  210.     $self->run_handlers("request_preprepare", $request);
  211.  
  212.     if (my $def_headers = $self->{def_headers}) {
  213.     for my $h ($def_headers->header_field_names) {
  214.         $request->init_header($h => [$def_headers->header($h)]);
  215.     }
  216.     }
  217.  
  218.     $self->run_handlers("request_prepare", $request);
  219.  
  220.     return $request;
  221. }
  222.  
  223.  
  224. sub simple_request
  225. {
  226.     my($self, $request, $arg, $size) = @_;
  227.  
  228.     # sanity check the request passed in
  229.     if (defined $request) {
  230.     if (ref $request) {
  231.         Carp::croak("You need a request object, not a " . ref($request) . " object")
  232.           if ref($request) eq 'ARRAY' or ref($request) eq 'HASH' or
  233.          !$request->can('method') or !$request->can('uri');
  234.     }
  235.     else {
  236.         Carp::croak("You need a request object, not '$request'");
  237.     }
  238.     }
  239.     else {
  240.         Carp::croak("No request object passed in");
  241.     }
  242.  
  243.     eval {
  244.     $request = $self->prepare_request($request);
  245.     };
  246.     if ($@) {
  247.     $@ =~ s/ at .* line \d+.*//s;  # remove file/line number
  248.     return _new_response($request, &HTTP::Status::RC_BAD_REQUEST, $@);
  249.     }
  250.     return $self->send_request($request, $arg, $size);
  251. }
  252.  
  253.  
  254. sub request
  255. {
  256.     my($self, $request, $arg, $size, $previous) = @_;
  257.  
  258.     my $response = $self->simple_request($request, $arg, $size);
  259.     $response->previous($previous) if $previous;
  260.  
  261.     if ($response->redirects >= $self->{max_redirect}) {
  262.         $response->header("Client-Warning" =>
  263.                           "Redirect loop detected (max_redirect = $self->{max_redirect})");
  264.         return $response;
  265.     }
  266.  
  267.     if (my $req = $self->run_handlers("response_redirect", $response)) {
  268.         return $self->request($req, $arg, $size, $response);
  269.     }
  270.  
  271.     my $code = $response->code;
  272.  
  273.     if ($code == &HTTP::Status::RC_MOVED_PERMANENTLY or
  274.     $code == &HTTP::Status::RC_FOUND or
  275.     $code == &HTTP::Status::RC_SEE_OTHER or
  276.     $code == &HTTP::Status::RC_TEMPORARY_REDIRECT)
  277.     {
  278.     my $referral = $request->clone;
  279.  
  280.     # These headers should never be forwarded
  281.     $referral->remove_header('Host', 'Cookie');
  282.     
  283.     if ($referral->header('Referer') &&
  284.         $request->uri->scheme eq 'https' &&
  285.         $referral->uri->scheme eq 'http')
  286.     {
  287.         # RFC 2616, section 15.1.3.
  288.         # https -> http redirect, suppressing Referer
  289.         $referral->remove_header('Referer');
  290.     }
  291.  
  292.     if ($code == &HTTP::Status::RC_SEE_OTHER ||
  293.         $code == &HTTP::Status::RC_FOUND) 
  294.         {
  295.         my $method = uc($referral->method);
  296.         unless ($method eq "GET" || $method eq "HEAD") {
  297.         $referral->method("GET");
  298.         $referral->content("");
  299.         $referral->remove_content_headers;
  300.         }
  301.     }
  302.  
  303.     # And then we update the URL based on the Location:-header.
  304.     my $referral_uri = $response->header('Location');
  305.     {
  306.         # Some servers erroneously return a relative URL for redirects,
  307.         # so make it absolute if it not already is.
  308.         local $URI::ABS_ALLOW_RELATIVE_SCHEME = 1;
  309.         my $base = $response->base;
  310.         $referral_uri = "" unless defined $referral_uri;
  311.         $referral_uri = $HTTP::URI_CLASS->new($referral_uri, $base)
  312.                     ->abs($base);
  313.     }
  314.     $referral->uri($referral_uri);
  315.  
  316.     return $response unless $self->redirect_ok($referral, $response);
  317.     return $self->request($referral, $arg, $size, $response);
  318.  
  319.     }
  320.     elsif ($code == &HTTP::Status::RC_UNAUTHORIZED ||
  321.          $code == &HTTP::Status::RC_PROXY_AUTHENTICATION_REQUIRED
  322.         )
  323.     {
  324.     my $proxy = ($code == &HTTP::Status::RC_PROXY_AUTHENTICATION_REQUIRED);
  325.     my $ch_header = $proxy ?  "Proxy-Authenticate" : "WWW-Authenticate";
  326.     my @challenge = $response->header($ch_header);
  327.     unless (@challenge) {
  328.         $response->header("Client-Warning" => 
  329.                   "Missing Authenticate header");
  330.         return $response;
  331.     }
  332.  
  333.     require HTTP::Headers::Util;
  334.     CHALLENGE: for my $challenge (@challenge) {
  335.         $challenge =~ tr/,/;/;  # "," is used to separate auth-params!!
  336.         ($challenge) = HTTP::Headers::Util::split_header_words($challenge);
  337.         my $scheme = shift(@$challenge);
  338.         shift(@$challenge); # no value
  339.         $challenge = { @$challenge };  # make rest into a hash
  340.  
  341.         unless ($scheme =~ /^([a-z]+(?:-[a-z]+)*)$/) {
  342.         $response->header("Client-Warning" => 
  343.                   "Bad authentication scheme '$scheme'");
  344.         return $response;
  345.         }
  346.         $scheme = $1;  # untainted now
  347.         my $class = "LWP::Authen::\u$scheme";
  348.         $class =~ s/-/_/g;
  349.  
  350.         no strict 'refs';
  351.         unless (%{"$class\::"}) {
  352.         # try to load it
  353.         eval "require $class";
  354.         if ($@) {
  355.             if ($@ =~ /^Can\'t locate/) {
  356.             $response->header("Client-Warning" =>
  357.                       "Unsupported authentication scheme '$scheme'");
  358.             }
  359.             else {
  360.             $response->header("Client-Warning" => $@);
  361.             }
  362.             next CHALLENGE;
  363.         }
  364.         }
  365.         unless ($class->can("authenticate")) {
  366.         $response->header("Client-Warning" =>
  367.                   "Unsupported authentication scheme '$scheme'");
  368.         next CHALLENGE;
  369.         }
  370.         return $class->authenticate($self, $proxy, $challenge, $response,
  371.                     $request, $arg, $size);
  372.     }
  373.     return $response;
  374.     }
  375.     return $response;
  376. }
  377.  
  378.  
  379. #
  380. # Now the shortcuts...
  381. #
  382. sub get {
  383.     require HTTP::Request::Common;
  384.     my($self, @parameters) = @_;
  385.     my @suff = $self->_process_colonic_headers(\@parameters,1);
  386.     return $self->request( HTTP::Request::Common::GET( @parameters ), @suff );
  387. }
  388.  
  389.  
  390. sub post {
  391.     require HTTP::Request::Common;
  392.     my($self, @parameters) = @_;
  393.     my @suff = $self->_process_colonic_headers(\@parameters, (ref($parameters[1]) ? 2 : 1));
  394.     return $self->request( HTTP::Request::Common::POST( @parameters ), @suff );
  395. }
  396.  
  397.  
  398. sub head {
  399.     require HTTP::Request::Common;
  400.     my($self, @parameters) = @_;
  401.     my @suff = $self->_process_colonic_headers(\@parameters,1);
  402.     return $self->request( HTTP::Request::Common::HEAD( @parameters ), @suff );
  403. }
  404.  
  405.  
  406. sub _process_colonic_headers {
  407.     # Process :content_cb / :content_file / :read_size_hint headers.
  408.     my($self, $args, $start_index) = @_;
  409.  
  410.     my($arg, $size);
  411.     for(my $i = $start_index; $i < @$args; $i += 2) {
  412.     next unless defined $args->[$i];
  413.  
  414.     #printf "Considering %s => %s\n", $args->[$i], $args->[$i + 1];
  415.  
  416.     if($args->[$i] eq ':content_cb') {
  417.         # Some sanity-checking...
  418.         $arg = $args->[$i + 1];
  419.         Carp::croak("A :content_cb value can't be undef") unless defined $arg;
  420.         Carp::croak("A :content_cb value must be a coderef")
  421.         unless ref $arg and UNIVERSAL::isa($arg, 'CODE');
  422.         
  423.     }
  424.     elsif ($args->[$i] eq ':content_file') {
  425.         $arg = $args->[$i + 1];
  426.  
  427.         # Some sanity-checking...
  428.         Carp::croak("A :content_file value can't be undef")
  429.         unless defined $arg;
  430.         Carp::croak("A :content_file value can't be a reference")
  431.         if ref $arg;
  432.         Carp::croak("A :content_file value can't be \"\"")
  433.         unless length $arg;
  434.  
  435.     }
  436.     elsif ($args->[$i] eq ':read_size_hint') {
  437.         $size = $args->[$i + 1];
  438.         # Bother checking it?
  439.  
  440.     }
  441.     else {
  442.         next;
  443.     }
  444.     splice @$args, $i, 2;
  445.     $i -= 2;
  446.     }
  447.  
  448.     # And return a suitable suffix-list for request(REQ,...)
  449.  
  450.     return             unless defined $arg;
  451.     return $arg, $size if     defined $size;
  452.     return $arg;
  453. }
  454.  
  455. my @ANI = qw(- \ | /);
  456.  
  457. sub progress {
  458.     my($self, $status, $m) = @_;
  459.     return unless $self->{show_progress};
  460.  
  461.     local($,, $\);
  462.     if ($status eq "begin") {
  463.         print STDERR "** ", $m->method, " ", $m->uri, " ==> ";
  464.         $self->{progress_start} = time;
  465.         $self->{progress_lastp} = "";
  466.         $self->{progress_ani} = 0;
  467.     }
  468.     elsif ($status eq "end") {
  469.         delete $self->{progress_lastp};
  470.         delete $self->{progress_ani};
  471.         print STDERR $m->status_line;
  472.         my $t = time - delete $self->{progress_start};
  473.         print STDERR " (${t}s)" if $t;
  474.         print STDERR "\n";
  475.     }
  476.     elsif ($status eq "tick") {
  477.         print STDERR "$ANI[$self->{progress_ani}++]\b";
  478.         $self->{progress_ani} %= @ANI;
  479.     }
  480.     else {
  481.         my $p = sprintf "%3.0f%%", $status * 100;
  482.         return if $p eq $self->{progress_lastp};
  483.         print STDERR "$p\b\b\b\b";
  484.         $self->{progress_lastp} = $p;
  485.     }
  486.     STDERR->flush;
  487. }
  488.  
  489.  
  490. #
  491. # This whole allow/forbid thing is based on man 1 at's way of doing things.
  492. #
  493. sub is_protocol_supported
  494. {
  495.     my($self, $scheme) = @_;
  496.     if (ref $scheme) {
  497.     # assume we got a reference to an URI object
  498.     $scheme = $scheme->scheme;
  499.     }
  500.     else {
  501.     Carp::croak("Illegal scheme '$scheme' passed to is_protocol_supported")
  502.         if $scheme =~ /\W/;
  503.     $scheme = lc $scheme;
  504.     }
  505.  
  506.     my $x;
  507.     if(ref($self) and $x       = $self->protocols_allowed) {
  508.       return 0 unless grep lc($_) eq $scheme, @$x;
  509.     }
  510.     elsif (ref($self) and $x = $self->protocols_forbidden) {
  511.       return 0 if grep lc($_) eq $scheme, @$x;
  512.     }
  513.  
  514.     local($SIG{__DIE__});  # protect against user defined die handlers
  515.     $x = LWP::Protocol::implementor($scheme);
  516.     return 1 if $x and $x ne 'LWP::Protocol::nogo';
  517.     return 0;
  518. }
  519.  
  520.  
  521. sub protocols_allowed      { shift->_elem('protocols_allowed'    , @_) }
  522. sub protocols_forbidden    { shift->_elem('protocols_forbidden'  , @_) }
  523. sub requests_redirectable  { shift->_elem('requests_redirectable', @_) }
  524.  
  525.  
  526. sub redirect_ok
  527. {
  528.     # RFC 2616, section 10.3.2 and 10.3.3 say:
  529.     #  If the 30[12] status code is received in response to a request other
  530.     #  than GET or HEAD, the user agent MUST NOT automatically redirect the
  531.     #  request unless it can be confirmed by the user, since this might
  532.     #  change the conditions under which the request was issued.
  533.  
  534.     # Note that this routine used to be just:
  535.     #  return 0 if $_[1]->method eq "POST";  return 1;
  536.  
  537.     my($self, $new_request, $response) = @_;
  538.     my $method = $response->request->method;
  539.     return 0 unless grep $_ eq $method,
  540.       @{ $self->requests_redirectable || [] };
  541.     
  542.     if ($new_request->uri->scheme eq 'file') {
  543.       $response->header("Client-Warning" =>
  544.             "Can't redirect to a file:// URL!");
  545.       return 0;
  546.     }
  547.     
  548.     # Otherwise it's apparently okay...
  549.     return 1;
  550. }
  551.  
  552.  
  553. sub credentials
  554. {
  555.     my $self = shift;
  556.     my $netloc = lc(shift);
  557.     my $realm = shift || "";
  558.     my $old = $self->{basic_authentication}{$netloc}{$realm};
  559.     if (@_) {
  560.         $self->{basic_authentication}{$netloc}{$realm} = [@_];
  561.     }
  562.     return unless $old;
  563.     return @$old if wantarray;
  564.     return join(":", @$old);
  565. }
  566.  
  567.  
  568. sub get_basic_credentials
  569. {
  570.     my($self, $realm, $uri, $proxy) = @_;
  571.     return if $proxy;
  572.     return $self->credentials($uri->host_port, $realm);
  573. }
  574.  
  575.  
  576. sub timeout      { shift->_elem('timeout',      @_); }
  577. sub max_size     { shift->_elem('max_size',     @_); }
  578. sub max_redirect { shift->_elem('max_redirect', @_); }
  579. sub show_progress{ shift->_elem('show_progress', @_); }
  580.  
  581. sub parse_head {
  582.     my $self = shift;
  583.     if (@_) {
  584.         my $flag = shift;
  585.         my $parser;
  586.         my $old = $self->set_my_handler("response_header", $flag ? sub {
  587.                my($response, $ua) = @_;
  588.                require HTML::HeadParser;
  589.                $parser = HTML::HeadParser->new;
  590.                $parser->xml_mode(1) if $response->content_is_xhtml;
  591.                $parser->utf8_mode(1) if $] >= 5.008 && $HTML::Parser::VERSION >= 3.40;
  592.  
  593.                push(@{$response->{handlers}{response_data}}, {
  594.            callback => sub {
  595.                return unless $parser;
  596.                unless ($parser->parse($_[3])) {
  597.                my $h = $parser->header;
  598.                my $r = $_[0];
  599.                for my $f ($h->header_field_names) {
  600.                    $r->init_header($f, [$h->header($f)]);
  601.                }
  602.                undef($parser);
  603.                }
  604.            },
  605.            });
  606.  
  607.             } : undef,
  608.             m_media_type => "html",
  609.         );
  610.         return !!$old;
  611.     }
  612.     else {
  613.         return !!$self->get_my_handler("response_header");
  614.     }
  615. }
  616.  
  617. sub cookie_jar {
  618.     my $self = shift;
  619.     my $old = $self->{cookie_jar};
  620.     if (@_) {
  621.     my $jar = shift;
  622.     if (ref($jar) eq "HASH") {
  623.         require HTTP::Cookies;
  624.         $jar = HTTP::Cookies->new(%$jar);
  625.     }
  626.     $self->{cookie_jar} = $jar;
  627.         $self->set_my_handler("request_prepare",
  628.             $jar ? sub { $jar->add_cookie_header($_[0]); } : undef,
  629.         );
  630.         $self->set_my_handler("response_done",
  631.             $jar ? sub { $jar->extract_cookies($_[0]); } : undef,
  632.         );
  633.     }
  634.     $old;
  635. }
  636.  
  637. sub default_headers {
  638.     my $self = shift;
  639.     my $old = $self->{def_headers} ||= HTTP::Headers->new;
  640.     if (@_) {
  641.     $self->{def_headers} = shift;
  642.     }
  643.     return $old;
  644. }
  645.  
  646. sub default_header {
  647.     my $self = shift;
  648.     return $self->default_headers->header(@_);
  649. }
  650.  
  651. sub _agent       { "libwww-perl/$LWP::VERSION" }
  652.  
  653. sub agent {
  654.     my $self = shift;
  655.     if (@_) {
  656.     my $agent = shift;
  657.         if ($agent) {
  658.             $agent .= $self->_agent if $agent =~ /\s+$/;
  659.         }
  660.         else {
  661.             undef($agent)
  662.         }
  663.         return $self->default_header("User-Agent", $agent);
  664.     }
  665.     return $self->default_header("User-Agent");
  666. }
  667.  
  668. sub from {  # legacy
  669.     my $self = shift;
  670.     return $self->default_header("From", @_);
  671. }
  672.  
  673.  
  674. sub conn_cache {
  675.     my $self = shift;
  676.     my $old = $self->{conn_cache};
  677.     if (@_) {
  678.     my $cache = shift;
  679.     if (ref($cache) eq "HASH") {
  680.         require LWP::ConnCache;
  681.         $cache = LWP::ConnCache->new(%$cache);
  682.     }
  683.     $self->{conn_cache} = $cache;
  684.     }
  685.     $old;
  686. }
  687.  
  688.  
  689. sub add_handler {
  690.     my($self, $phase, $cb, %spec) = @_;
  691.     $spec{line} ||= join(":", (caller)[1,2]);
  692.     my $conf = $self->{handlers}{$phase} ||= do {
  693.         require HTTP::Config;
  694.         HTTP::Config->new;
  695.     };
  696.     $conf->add(%spec, callback => $cb);
  697. }
  698.  
  699. sub set_my_handler {
  700.     my($self, $phase, $cb, %spec) = @_;
  701.     $spec{owner} = (caller(1))[3] unless exists $spec{owner};
  702.     $self->remove_handler($phase, %spec);
  703.     $spec{line} ||= join(":", (caller)[1,2]);
  704.     $self->add_handler($phase, $cb, %spec) if $cb;
  705. }
  706.  
  707. sub get_my_handler {
  708.     my $self = shift;
  709.     my $phase = shift;
  710.     my $init = pop if @_ % 2;
  711.     my %spec = @_;
  712.     my $conf = $self->{handlers}{$phase};
  713.     unless ($conf) {
  714.         return unless $init;
  715.         require HTTP::Config;
  716.         $conf = $self->{handlers}{$phase} = HTTP::Config->new;
  717.     }
  718.     $spec{owner} = (caller(1))[3] unless exists $spec{owner};
  719.     my @h = $conf->find(%spec);
  720.     if (!@h && $init) {
  721.         if (ref($init) eq "CODE") {
  722.             $init->(\%spec);
  723.         }
  724.         elsif (ref($init) eq "HASH") {
  725.             while (my($k, $v) = each %$init) {
  726.                 $spec{$k} = $v;
  727.             }
  728.         }
  729.         $spec{callback} ||= sub {};
  730.         $spec{line} ||= join(":", (caller)[1,2]);
  731.         $conf->add(\%spec);
  732.         return \%spec;
  733.     }
  734.     return wantarray ? @h : $h[0];
  735. }
  736.  
  737. sub remove_handler {
  738.     my($self, $phase, %spec) = @_;
  739.     if ($phase) {
  740.         my $conf = $self->{handlers}{$phase} || return;
  741.         my @h = $conf->remove(%spec);
  742.         delete $self->{handlers}{$phase} if $conf->empty;
  743.         return @h;
  744.     }
  745.  
  746.     return unless $self->{handlers};
  747.     return map $self->remove_handler($_), sort keys %{$self->{handlers}};
  748. }
  749.  
  750. sub handlers {
  751.     my($self, $phase, $o) = @_;
  752.     my @h;
  753.     if ($o->{handlers} && $o->{handlers}{$phase}) {
  754.         push(@h, @{$o->{handlers}{$phase}});
  755.     }
  756.     if (my $conf = $self->{handlers}{$phase}) {
  757.         push(@h, $conf->matching($o));
  758.     }
  759.     return @h;
  760. }
  761.  
  762. sub run_handlers {
  763.     my($self, $phase, $o) = @_;
  764.     if (defined(wantarray)) {
  765.         for my $h ($self->handlers($phase, $o)) {
  766.             my $ret = $h->{callback}->($o, $self, $h);
  767.             return $ret if $ret;
  768.         }
  769.         return undef;
  770.     }
  771.  
  772.     for my $h ($self->handlers($phase, $o)) {
  773.         $h->{callback}->($o, $self, $h);
  774.     }
  775. }
  776.  
  777.  
  778. # depreciated
  779. sub use_eval   { shift->_elem('use_eval',  @_); }
  780. sub use_alarm
  781. {
  782.     Carp::carp("LWP::UserAgent->use_alarm(BOOL) is a no-op")
  783.     if @_ > 1 && $^W;
  784.     "";
  785. }
  786.  
  787.  
  788. sub clone
  789. {
  790.     my $self = shift;
  791.     my $copy = bless { %$self }, ref $self;  # copy most fields
  792.  
  793.     delete $copy->{handlers};
  794.     delete $copy->{conn_cache};
  795.  
  796.     # copy any plain arrays and hashes; known not to need recursive copy
  797.     for my $k (qw(proxy no_proxy requests_redirectable)) {
  798.         next unless $copy->{$k};
  799.         if (ref($copy->{$k}) eq "ARRAY") {
  800.             $copy->{$k} = [ @{$copy->{$k}} ];
  801.         }
  802.         elsif (ref($copy->{$k}) eq "HASH") {
  803.             $copy->{$k} = { %{$copy->{$k}} };
  804.         }
  805.     }
  806.  
  807.     if ($self->{def_headers}) {
  808.         $copy->{def_headers} = $self->{def_headers}->clone;
  809.     }
  810.  
  811.     # re-enable standard handlers
  812.     $copy->parse_head($self->parse_head);
  813.  
  814.     # no easy way to clone the cookie jar; so let's just remove it for now
  815.     $copy->cookie_jar(undef);
  816.  
  817.     $copy;
  818. }
  819.  
  820.  
  821. sub mirror
  822. {
  823.     my($self, $url, $file) = @_;
  824.  
  825.     my $request = HTTP::Request->new('GET', $url);
  826.  
  827.     # If the file exists, add a cache-related header
  828.     if ( -e $file ) {
  829.         my ($mtime) = ( stat($file) )[9];
  830.         if ($mtime) {
  831.             $request->header( 'If-Modified-Since' => HTTP::Date::time2str($mtime) );
  832.         }
  833.     }
  834.     my $tmpfile = "$file-$$";
  835.  
  836.     my $response = $self->request($request, $tmpfile);
  837.  
  838.     # Only fetching a fresh copy of the would be considered success.
  839.     # If the file was not modified, "304" would returned, which 
  840.     # is considered by HTTP::Status to be a "redirect", /not/ "success"
  841.     if ( $response->is_success ) {
  842.         my $file_length = ( stat($tmpfile) )[7];
  843.         my ($content_length) = $response->header('Content-length');
  844.  
  845.         if ( defined $content_length and $file_length < $content_length ) {
  846.             unlink($tmpfile);
  847.             die "Transfer truncated: " . "only $file_length out of $content_length bytes received\n";
  848.         }
  849.         elsif ( defined $content_length and $file_length > $content_length ) {
  850.             unlink($tmpfile);
  851.             die "Content-length mismatch: " . "expected $content_length bytes, got $file_length\n";
  852.         }
  853.         # The file was the expected length. 
  854.         else {
  855.             # Replace the stale file with a fresh copy
  856.             if ( -e $file ) {
  857.                 # Some dosish systems fail to rename if the target exists
  858.                 chmod 0777, $file;
  859.                 unlink $file;
  860.             }
  861.             rename( $tmpfile, $file )
  862.                 or die "Cannot rename '$tmpfile' to '$file': $!\n";
  863.  
  864.             # make sure the file has the same last modification time
  865.             if ( my $lm = $response->last_modified ) {
  866.                 utime $lm, $lm, $file;
  867.             }
  868.         }
  869.     }
  870.     # The local copy is fresh enough, so just delete the temp file  
  871.     else {
  872.     unlink($tmpfile);
  873.     }
  874.     return $response;
  875. }
  876.  
  877.  
  878. sub _need_proxy {
  879.     my($req, $ua) = @_;
  880.     return if exists $req->{proxy};
  881.     my $proxy = $ua->{proxy}{$req->uri->scheme} || return;
  882.     if ($ua->{no_proxy}) {
  883.         if (my $host = eval { $req->uri->host }) {
  884.             for my $domain (@{$ua->{no_proxy}}) {
  885.                 if ($host =~ /\Q$domain\E$/) {
  886.                     return;
  887.                 }
  888.             }
  889.         }
  890.     }
  891.     $req->{proxy} = $HTTP::URI_CLASS->new($proxy);
  892. }
  893.  
  894.  
  895. sub proxy
  896. {
  897.     my $self = shift;
  898.     my $key  = shift;
  899.     return map $self->proxy($_, @_), @$key if ref $key;
  900.  
  901.     Carp::croak("'$key' is not a valid URI scheme") unless $key =~ /^$URI::scheme_re\z/;
  902.     my $old = $self->{'proxy'}{$key};
  903.     if (@_) {
  904.         my $url = shift;
  905.         if (defined($url) && length($url)) {
  906.             Carp::croak("Proxy must be specified as absolute URI; '$url' is not") unless $url =~ /^$URI::scheme_re:/;
  907.             Carp::croak("Bad http proxy specification '$url'") if $url =~ /^https?:/ && $url !~ m,^https?://\w,;
  908.         }
  909.         $self->{proxy}{$key} = $url;
  910.         $self->set_my_handler("request_preprepare", \&_need_proxy)
  911.     }
  912.     return $old;
  913. }
  914.  
  915.  
  916. sub env_proxy {
  917.     my ($self) = @_;
  918.     my($k,$v);
  919.     while(($k, $v) = each %ENV) {
  920.     if ($ENV{REQUEST_METHOD}) {
  921.         # Need to be careful when called in the CGI environment, as
  922.         # the HTTP_PROXY variable is under control of that other guy.
  923.         next if $k =~ /^HTTP_/;
  924.         $k = "HTTP_PROXY" if $k eq "CGI_HTTP_PROXY";
  925.     }
  926.     $k = lc($k);
  927.     next unless $k =~ /^(.*)_proxy$/;
  928.     $k = $1;
  929.     if ($k eq 'no') {
  930.         $self->no_proxy(split(/\s*,\s*/, $v));
  931.     }
  932.     else {
  933.             # Ignore random _proxy variables, allow only valid schemes
  934.             next unless $k =~ /^$URI::scheme_re\z/;
  935.         $self->proxy($k, $v);
  936.     }
  937.     }
  938. }
  939.  
  940.  
  941. sub no_proxy {
  942.     my($self, @no) = @_;
  943.     if (@no) {
  944.     push(@{ $self->{'no_proxy'} }, @no);
  945.     }
  946.     else {
  947.     $self->{'no_proxy'} = [];
  948.     }
  949. }
  950.  
  951.  
  952. sub _new_response {
  953.     my($request, $code, $message) = @_;
  954.     my $response = HTTP::Response->new($code, $message);
  955.     $response->request($request);
  956.     $response->header("Client-Date" => HTTP::Date::time2str(time));
  957.     $response->header("Client-Warning" => "Internal response");
  958.     $response->header("Content-Type" => "text/plain");
  959.     $response->content("$code $message\n");
  960.     return $response;
  961. }
  962.  
  963.  
  964. 1;
  965.  
  966. __END__
  967.  
  968. =head1 NAME
  969.  
  970. LWP::UserAgent - Web user agent class
  971.  
  972. =head1 SYNOPSIS
  973.  
  974.  require LWP::UserAgent;
  975.  
  976.  my $ua = LWP::UserAgent->new;
  977.  $ua->timeout(10);
  978.  $ua->env_proxy;
  979.  
  980.  my $response = $ua->get('http://search.cpan.org/');
  981.  
  982.  if ($response->is_success) {
  983.      print $response->decoded_content;  # or whatever
  984.  }
  985.  else {
  986.      die $response->status_line;
  987.  }
  988.  
  989. =head1 DESCRIPTION
  990.  
  991. The C<LWP::UserAgent> is a class implementing a web user agent.
  992. C<LWP::UserAgent> objects can be used to dispatch web requests.
  993.  
  994. In normal use the application creates an C<LWP::UserAgent> object, and
  995. then configures it with values for timeouts, proxies, name, etc. It
  996. then creates an instance of C<HTTP::Request> for the request that
  997. needs to be performed. This request is then passed to one of the
  998. request method the UserAgent, which dispatches it using the relevant
  999. protocol, and returns a C<HTTP::Response> object.  There are
  1000. convenience methods for sending the most common request types: get(),
  1001. head() and post().  When using these methods then the creation of the
  1002. request object is hidden as shown in the synopsis above.
  1003.  
  1004. The basic approach of the library is to use HTTP style communication
  1005. for all protocol schemes.  This means that you will construct
  1006. C<HTTP::Request> objects and receive C<HTTP::Response> objects even
  1007. for non-HTTP resources like I<gopher> and I<ftp>.  In order to achieve
  1008. even more similarity to HTTP style communications, gopher menus and
  1009. file directories are converted to HTML documents.
  1010.  
  1011. =head1 CONSTRUCTOR METHODS
  1012.  
  1013. The following constructor methods are available:
  1014.  
  1015. =over 4
  1016.  
  1017. =item $ua = LWP::UserAgent->new( %options )
  1018.  
  1019. This method constructs a new C<LWP::UserAgent> object and returns it.
  1020. Key/value pair arguments may be provided to set up the initial state.
  1021. The following options correspond to attribute methods described below:
  1022.  
  1023.    KEY                     DEFAULT
  1024.    -----------             --------------------
  1025.    agent                   "libwww-perl/#.###"
  1026.    from                    undef
  1027.    conn_cache              undef
  1028.    cookie_jar              undef
  1029.    default_headers         HTTP::Headers->new
  1030.    max_size                undef
  1031.    max_redirect            7
  1032.    parse_head              1
  1033.    protocols_allowed       undef
  1034.    protocols_forbidden     undef
  1035.    requests_redirectable   ['GET', 'HEAD']
  1036.    timeout                 180
  1037.  
  1038. The following additional options are also accepted: If the
  1039. C<env_proxy> option is passed in with a TRUE value, then proxy
  1040. settings are read from environment variables (see env_proxy() method
  1041. below).  If the C<keep_alive> option is passed in, then a
  1042. C<LWP::ConnCache> is set up (see conn_cache() method below).  The
  1043. C<keep_alive> value is passed on as the C<total_capacity> for the
  1044. connection cache.
  1045.  
  1046. =item $ua->clone
  1047.  
  1048. Returns a copy of the LWP::UserAgent object.
  1049.  
  1050. =back
  1051.  
  1052. =head1 ATTRIBUTES
  1053.  
  1054. The settings of the configuration attributes modify the behaviour of the
  1055. C<LWP::UserAgent> when it dispatches requests.  Most of these can also
  1056. be initialized by options passed to the constructor method.
  1057.  
  1058. The following attributes methods are provided.  The attribute value is
  1059. left unchanged if no argument is given.  The return value from each
  1060. method is the old attribute value.
  1061.  
  1062. =over
  1063.  
  1064. =item $ua->agent
  1065.  
  1066. =item $ua->agent( $product_id )
  1067.  
  1068. Get/set the product token that is used to identify the user agent on
  1069. the network.  The agent value is sent as the "User-Agent" header in
  1070. the requests.  The default is the string returned by the _agent()
  1071. method (see below).
  1072.  
  1073. If the $product_id ends with space then the _agent() string is
  1074. appended to it.
  1075.  
  1076. The user agent string should be one or more simple product identifiers
  1077. with an optional version number separated by the "/" character.
  1078. Examples are:
  1079.  
  1080.   $ua->agent('Checkbot/0.4 ' . $ua->_agent);
  1081.   $ua->agent('Checkbot/0.4 ');    # same as above
  1082.   $ua->agent('Mozilla/5.0');
  1083.   $ua->agent("");                 # don't identify
  1084.  
  1085. =item $ua->_agent
  1086.  
  1087. Returns the default agent identifier.  This is a string of the form
  1088. "libwww-perl/#.###", where "#.###" is substituted with the version number
  1089. of this library.
  1090.  
  1091. =item $ua->from
  1092.  
  1093. =item $ua->from( $email_address )
  1094.  
  1095. Get/set the e-mail address for the human user who controls
  1096. the requesting user agent.  The address should be machine-usable, as
  1097. defined in RFC 822.  The C<from> value is send as the "From" header in
  1098. the requests.  Example:
  1099.  
  1100.   $ua->from('gaas@cpan.org');
  1101.  
  1102. The default is to not send a "From" header.  See the default_headers()
  1103. method for the more general interface that allow any header to be defaulted.
  1104.  
  1105. =item $ua->cookie_jar
  1106.  
  1107. =item $ua->cookie_jar( $cookie_jar_obj )
  1108.  
  1109. Get/set the cookie jar object to use.  The only requirement is that
  1110. the cookie jar object must implement the extract_cookies($request) and
  1111. add_cookie_header($response) methods.  These methods will then be
  1112. invoked by the user agent as requests are sent and responses are
  1113. received.  Normally this will be a C<HTTP::Cookies> object or some
  1114. subclass.
  1115.  
  1116. The default is to have no cookie_jar, i.e. never automatically add
  1117. "Cookie" headers to the requests.
  1118.  
  1119. Shortcut: If a reference to a plain hash is passed in as the
  1120. $cookie_jar_object, then it is replaced with an instance of
  1121. C<HTTP::Cookies> that is initialized based on the hash.  This form also
  1122. automatically loads the C<HTTP::Cookies> module.  It means that:
  1123.  
  1124.   $ua->cookie_jar({ file => "$ENV{HOME}/.cookies.txt" });
  1125.  
  1126. is really just a shortcut for:
  1127.  
  1128.   require HTTP::Cookies;
  1129.   $ua->cookie_jar(HTTP::Cookies->new(file => "$ENV{HOME}/.cookies.txt"));
  1130.  
  1131. =item $ua->default_headers
  1132.  
  1133. =item $ua->default_headers( $headers_obj )
  1134.  
  1135. Get/set the headers object that will provide default header values for
  1136. any requests sent.  By default this will be an empty C<HTTP::Headers>
  1137. object.
  1138.  
  1139. =item $ua->default_header( $field )
  1140.  
  1141. =item $ua->default_header( $field => $value )
  1142.  
  1143. This is just a short-cut for $ua->default_headers->header( $field =>
  1144. $value ). Example:
  1145.  
  1146.   $ua->default_header('Accept-Encoding' => scalar HTTP::Message::decodable());
  1147.   $ua->default_header('Accept-Language' => "no, en");
  1148.  
  1149. =item $ua->conn_cache
  1150.  
  1151. =item $ua->conn_cache( $cache_obj )
  1152.  
  1153. Get/set the C<LWP::ConnCache> object to use.  See L<LWP::ConnCache>
  1154. for details.
  1155.  
  1156. =item $ua->credentials( $netloc, $realm )
  1157.  
  1158. =item $ua->credentials( $netloc, $realm, $uname, $pass )
  1159.  
  1160. Get/set the user name and password to be used for a realm.
  1161.  
  1162. The $netloc is a string of the form "<host>:<port>".  The username and
  1163. password will only be passed to this server.  Example:
  1164.  
  1165.   $ua->credentials("www.example.com:80", "Some Realm", "foo", "secret");
  1166.  
  1167. =item $ua->max_size
  1168.  
  1169. =item $ua->max_size( $bytes )
  1170.  
  1171. Get/set the size limit for response content.  The default is C<undef>,
  1172. which means that there is no limit.  If the returned response content
  1173. is only partial, because the size limit was exceeded, then a
  1174. "Client-Aborted" header will be added to the response.  The content
  1175. might end up longer than C<max_size> as we abort once appending a
  1176. chunk of data makes the length exceed the limit.  The "Content-Length"
  1177. header, if present, will indicate the length of the full content and
  1178. will normally not be the same as C<< length($res->content) >>.
  1179.  
  1180. =item $ua->max_redirect
  1181.  
  1182. =item $ua->max_redirect( $n )
  1183.  
  1184. This reads or sets the object's limit of how many times it will obey
  1185. redirection responses in a given request cycle.
  1186.  
  1187. By default, the value is 7. This means that if you call request()
  1188. method and the response is a redirect elsewhere which is in turn a
  1189. redirect, and so on seven times, then LWP gives up after that seventh
  1190. request.
  1191.  
  1192. =item $ua->parse_head
  1193.  
  1194. =item $ua->parse_head( $boolean )
  1195.  
  1196. Get/set a value indicating whether we should initialize response
  1197. headers from the E<lt>head> section of HTML documents. The default is
  1198. TRUE.  Do not turn this off, unless you know what you are doing.
  1199.  
  1200. =item $ua->protocols_allowed
  1201.  
  1202. =item $ua->protocols_allowed( \@protocols )
  1203.  
  1204. This reads (or sets) this user agent's list of protocols that the
  1205. request methods will exclusively allow.  The protocol names are case
  1206. insensitive.
  1207.  
  1208. For example: C<$ua-E<gt>protocols_allowed( [ 'http', 'https'] );>
  1209. means that this user agent will I<allow only> those protocols,
  1210. and attempts to use this user agent to access URLs with any other
  1211. schemes (like "ftp://...") will result in a 500 error.
  1212.  
  1213. To delete the list, call: C<$ua-E<gt>protocols_allowed(undef)>
  1214.  
  1215. By default, an object has neither a C<protocols_allowed> list, nor a
  1216. C<protocols_forbidden> list.
  1217.  
  1218. Note that having a C<protocols_allowed> list causes any
  1219. C<protocols_forbidden> list to be ignored.
  1220.  
  1221. =item $ua->protocols_forbidden
  1222.  
  1223. =item $ua->protocols_forbidden( \@protocols )
  1224.  
  1225. This reads (or sets) this user agent's list of protocols that the
  1226. request method will I<not> allow. The protocol names are case
  1227. insensitive.
  1228.  
  1229. For example: C<$ua-E<gt>protocols_forbidden( [ 'file', 'mailto'] );>
  1230. means that this user agent will I<not> allow those protocols, and
  1231. attempts to use this user agent to access URLs with those schemes
  1232. will result in a 500 error.
  1233.  
  1234. To delete the list, call: C<$ua-E<gt>protocols_forbidden(undef)>
  1235.  
  1236. =item $ua->requests_redirectable
  1237.  
  1238. =item $ua->requests_redirectable( \@requests )
  1239.  
  1240. This reads or sets the object's list of request names that
  1241. C<$ua-E<gt>redirect_ok(...)> will allow redirection for.  By
  1242. default, this is C<['GET', 'HEAD']>, as per RFC 2616.  To
  1243. change to include 'POST', consider:
  1244.  
  1245.    push @{ $ua->requests_redirectable }, 'POST';
  1246.  
  1247. =item $ua->show_progress
  1248.  
  1249. =item $ua->show_progress( $boolean )
  1250.  
  1251. Get/set a value indicating whether a progress bar should be displayed
  1252. on on the terminal as requests are processed. The default is FALSE.
  1253.  
  1254. =item $ua->timeout
  1255.  
  1256. =item $ua->timeout( $secs )
  1257.  
  1258. Get/set the timeout value in seconds. The default timeout() value is
  1259. 180 seconds, i.e. 3 minutes.
  1260.  
  1261. The requests is aborted if no activity on the connection to the server
  1262. is observed for C<timeout> seconds.  This means that the time it takes
  1263. for the complete transaction and the request() method to actually
  1264. return might be longer.
  1265.  
  1266. =back
  1267.  
  1268. =head2 Proxy attributes
  1269.  
  1270. The following methods set up when requests should be passed via a
  1271. proxy server.
  1272.  
  1273. =over
  1274.  
  1275. =item $ua->proxy(\@schemes, $proxy_url)
  1276.  
  1277. =item $ua->proxy($scheme, $proxy_url)
  1278.  
  1279. Set/retrieve proxy URL for a scheme:
  1280.  
  1281.  $ua->proxy(['http', 'ftp'], 'http://proxy.sn.no:8001/');
  1282.  $ua->proxy('gopher', 'http://proxy.sn.no:8001/');
  1283.  
  1284. The first form specifies that the URL is to be used for proxying of
  1285. access methods listed in the list in the first method argument,
  1286. i.e. 'http' and 'ftp'.
  1287.  
  1288. The second form shows a shorthand form for specifying
  1289. proxy URL for a single access scheme.
  1290.  
  1291. =item $ua->no_proxy( $domain, ... )
  1292.  
  1293. Do not proxy requests to the given domains.  Calling no_proxy without
  1294. any domains clears the list of domains. Eg:
  1295.  
  1296.  $ua->no_proxy('localhost', 'example.com');
  1297.  
  1298. =item $ua->env_proxy
  1299.  
  1300. Load proxy settings from *_proxy environment variables.  You might
  1301. specify proxies like this (sh-syntax):
  1302.  
  1303.   gopher_proxy=http://proxy.my.place/
  1304.   wais_proxy=http://proxy.my.place/
  1305.   no_proxy="localhost,example.com"
  1306.   export gopher_proxy wais_proxy no_proxy
  1307.  
  1308. csh or tcsh users should use the C<setenv> command to define these
  1309. environment variables.
  1310.  
  1311. On systems with case insensitive environment variables there exists a
  1312. name clash between the CGI environment variables and the C<HTTP_PROXY>
  1313. environment variable normally picked up by env_proxy().  Because of
  1314. this C<HTTP_PROXY> is not honored for CGI scripts.  The
  1315. C<CGI_HTTP_PROXY> environment variable can be used instead.
  1316.  
  1317. =back
  1318.  
  1319. =head2 Handlers
  1320.  
  1321. Handlers are code that injected at various phases during the
  1322. processing of requests.  The following methods are provided to manage
  1323. the active handlers:
  1324.  
  1325. =over
  1326.  
  1327. =item $ua->add_handler( $phase => \&cb, %matchspec )
  1328.  
  1329. Add handler to be invoked in the given processing phase.  For how to
  1330. specify %matchspec see L<HTTP::Config/"Matching">.
  1331.  
  1332. The possible values $phase and the corresponding callback signatures are:
  1333.  
  1334. =over
  1335.  
  1336. =item request_preprepare => sub { my($request, $ua, $h) = @_; ... }
  1337.  
  1338. The handler is called before the C<request_prepare> and other standard
  1339. initialization of of the request.  This can be used to set up headers
  1340. and attributes that the C<request_prepare> handler depends on.  Proxy
  1341. initialization should take place here; but in general don't register
  1342. handlers for this phase.
  1343.  
  1344. =item request_prepare => sub { my($request, $ua, $h) = @_; ... }
  1345.  
  1346. The handler is called before the request is sent and can modify the
  1347. request any way it see fit.  This can for instance be used to add
  1348. certain headers to specific requests.
  1349.  
  1350. The method can assign a new request object to $_[0] to replace the
  1351. request that is sent fully.
  1352.  
  1353. The return value from the callback is ignored.  If an exceptions is
  1354. raised it will abort the request and make the request method return a
  1355. "400 Bad request" response.
  1356.  
  1357. =item request_send => sub { my($request, $ua, $h) = @_; ... }
  1358.  
  1359. This handler get a chance of handling requests before it's sent to the
  1360. protocol handlers.  It should return an HTTP::Response object if it
  1361. wishes to terminate the processing; otherwise it should return nothing.
  1362.  
  1363. The C<response_header> and C<response_data> handlers will not be
  1364. invoked for this response, but the C<response_done> will be.
  1365.  
  1366. =item response_header => sub { my($response, $ua, $h) = @_; ... }
  1367.  
  1368. This handler is called right after the response headers have been
  1369. received, but before any content data.  The handler might set up
  1370. handlers for data and might croak to abort the request.
  1371.  
  1372. The handler might set the $response->{default_add_content} value to
  1373. control if any received data should be added to the response object
  1374. directly.  This will initially be false if the $ua->request() method
  1375. was called with a ':content_filename' or ':content_callbak' argument;
  1376. otherwise true.
  1377.  
  1378. =item response_data => sub { my($response, $ua, $h, $data) = @_; ... }
  1379.  
  1380. This handlers is called for each chunk of data received for the
  1381. response.  The handler might croak to abort the request.
  1382.  
  1383. This handler need to return a TRUE value to be called again for
  1384. subsequent chunks for the same request.
  1385.  
  1386. =item response_done => sub { my($response, $ua, $h) = @_; ... }
  1387.  
  1388. The handler is called after the response has been fully received, but
  1389. before any redirect handling is attempted.  The handler can be used to
  1390. extract information or modify the response.
  1391.  
  1392. =item response_redirect => sub { my($response, $ua, $h) = @_; ... }
  1393.  
  1394. The handler is called in $ua->request after C<response_done>.  If the
  1395. handler return an HTTP::Request object we'll start over with processing
  1396. this request instead.
  1397.  
  1398. =back
  1399.  
  1400. =item $ua->remove_handler( undef, %matchspec )
  1401.  
  1402. =item $ua->remove_handler( $phase, %matchspec )
  1403.  
  1404. Remove handlers that match the given %matchspec.  If $phase is not
  1405. provided remove handlers from all phases.
  1406.  
  1407. Be careful as calling this function with %matchspec that is not not
  1408. specific enough can remove handlers not owned by you.  It's probably
  1409. better to use the set_my_handler() method instead.
  1410.  
  1411. The removed handlers are returned.
  1412.  
  1413. =item $ua->set_my_handler( $phase, $cb, %matchspec )
  1414.  
  1415. Set handlers private to the executing subroutine.  Works by defaulting
  1416. an C<owner> field to the %matchhspec that holds the name of the called
  1417. subroutine.  You might pass an explicit C<owner> to override this.
  1418.  
  1419. If $cb is passed as C<undef>, remove the handler.
  1420.  
  1421. =item $ua->get_my_handler( $phase, %matchspec )
  1422.  
  1423. =item $ua->get_my_handler( $phase, %matchspec, $init )
  1424.  
  1425. Will retrieve the matching handler as hash ref.
  1426.  
  1427. If C<$init> is passed passed as a TRUE value, create and add the
  1428. handler if it's not found.  If $init is a subroutine reference, then
  1429. it's called with the created handler hash as argument.  This sub might
  1430. populate the hash with extra fields; especially the callback.  If
  1431. $init is a hash reference, merge the hashes.
  1432.  
  1433. =item $ua->handlers( $phase, $request )
  1434.  
  1435. =item $ua->handlers( $phase, $response )
  1436.  
  1437. Returns the handlers that apply to the given request or response at
  1438. the given processing phase.
  1439.  
  1440. =back
  1441.  
  1442. =head1 REQUEST METHODS
  1443.  
  1444. The methods described in this section are used to dispatch requests
  1445. via the user agent.  The following request methods are provided:
  1446.  
  1447. =over
  1448.  
  1449. =item $ua->get( $url )
  1450.  
  1451. =item $ua->get( $url , $field_name => $value, ... )
  1452.  
  1453. This method will dispatch a C<GET> request on the given $url.  Further
  1454. arguments can be given to initialize the headers of the request. These
  1455. are given as separate name/value pairs.  The return value is a
  1456. response object.  See L<HTTP::Response> for a description of the
  1457. interface it provides.
  1458.  
  1459. There will still be a response object returned when LWP can't connect to the
  1460. server specified in the URL or when other failures in protocol handlers occur.
  1461. These internal responses use the standard HTTP status codes, so the responses
  1462. can't be differentiated by testing the response status code alone.  Error
  1463. responses that LWP generates internally will have the "Client-Warning" header
  1464. set to the value "Internal response".  If you need to differentiate these
  1465. internal responses from responses that a remote server actually generates, you
  1466. need to test this header value.
  1467.  
  1468. Fields names that start with ":" are special.  These will not
  1469. initialize headers of the request but will determine how the response
  1470. content is treated.  The following special field names are recognized:
  1471.  
  1472.     :content_file   => $filename
  1473.     :content_cb     => \&callback
  1474.     :read_size_hint => $bytes
  1475.  
  1476. If a $filename is provided with the C<:content_file> option, then the
  1477. response content will be saved here instead of in the response
  1478. object.  If a callback is provided with the C<:content_cb> option then
  1479. this function will be called for each chunk of the response content as
  1480. it is received from the server.  If neither of these options are
  1481. given, then the response content will accumulate in the response
  1482. object itself.  This might not be suitable for very large response
  1483. bodies.  Only one of C<:content_file> or C<:content_cb> can be
  1484. specified.  The content of unsuccessful responses will always
  1485. accumulate in the response object itself, regardless of the
  1486. C<:content_file> or C<:content_cb> options passed in.
  1487.  
  1488. The C<:read_size_hint> option is passed to the protocol module which
  1489. will try to read data from the server in chunks of this size.  A
  1490. smaller value for the C<:read_size_hint> will result in a higher
  1491. number of callback invocations.
  1492.  
  1493. The callback function is called with 3 arguments: a chunk of data, a
  1494. reference to the response object, and a reference to the protocol
  1495. object.  The callback can abort the request by invoking die().  The
  1496. exception message will show up as the "X-Died" header field in the
  1497. response returned by the get() function.
  1498.  
  1499. =item $ua->head( $url )
  1500.  
  1501. =item $ua->head( $url , $field_name => $value, ... )
  1502.  
  1503. This method will dispatch a C<HEAD> request on the given $url.
  1504. Otherwise it works like the get() method described above.
  1505.  
  1506. =item $ua->post( $url, \%form )
  1507.  
  1508. =item $ua->post( $url, \@form )
  1509.  
  1510. =item $ua->post( $url, \%form, $field_name => $value, ... )
  1511.  
  1512. =item $ua->post( $url, $field_name => $value,... Content => \%form )
  1513.  
  1514. =item $ua->post( $url, $field_name => $value,... Content => \@form )
  1515.  
  1516. =item $ua->post( $url, $field_name => $value,... Content => $content )
  1517.  
  1518. This method will dispatch a C<POST> request on the given $url, with
  1519. %form or @form providing the key/value pairs for the fill-in form
  1520. content. Additional headers and content options are the same as for
  1521. the get() method.
  1522.  
  1523. This method will use the POST() function from C<HTTP::Request::Common>
  1524. to build the request.  See L<HTTP::Request::Common> for a details on
  1525. how to pass form content and other advanced features.
  1526.  
  1527. =item $ua->mirror( $url, $filename )
  1528.  
  1529. This method will get the document identified by $url and store it in
  1530. file called $filename.  If the file already exists, then the request
  1531. will contain an "If-Modified-Since" header matching the modification
  1532. time of the file.  If the document on the server has not changed since
  1533. this time, then nothing happens.  If the document has been updated, it
  1534. will be downloaded again.  The modification time of the file will be
  1535. forced to match that of the server.
  1536.  
  1537. The return value is the the response object.
  1538.  
  1539. =item $ua->request( $request )
  1540.  
  1541. =item $ua->request( $request, $content_file )
  1542.  
  1543. =item $ua->request( $request, $content_cb )
  1544.  
  1545. =item $ua->request( $request, $content_cb, $read_size_hint )
  1546.  
  1547. This method will dispatch the given $request object.  Normally this
  1548. will be an instance of the C<HTTP::Request> class, but any object with
  1549. a similar interface will do.  The return value is a response object.
  1550. See L<HTTP::Request> and L<HTTP::Response> for a description of the
  1551. interface provided by these classes.
  1552.  
  1553. The request() method will process redirects and authentication
  1554. responses transparently.  This means that it may actually send several
  1555. simple requests via the simple_request() method described below.
  1556.  
  1557. The request methods described above; get(), head(), post() and
  1558. mirror(), will all dispatch the request they build via this method.
  1559. They are convenience methods that simply hides the creation of the
  1560. request object for you.
  1561.  
  1562. The $content_file, $content_cb and $read_size_hint all correspond to
  1563. options described with the get() method above.
  1564.  
  1565. You are allowed to use a CODE reference as C<content> in the request
  1566. object passed in.  The C<content> function should return the content
  1567. when called.  The content can be returned in chunks.  The content
  1568. function will be invoked repeatedly until it return an empty string to
  1569. signal that there is no more content.
  1570.  
  1571. =item $ua->simple_request( $request )
  1572.  
  1573. =item $ua->simple_request( $request, $content_file )
  1574.  
  1575. =item $ua->simple_request( $request, $content_cb )
  1576.  
  1577. =item $ua->simple_request( $request, $content_cb, $read_size_hint )
  1578.  
  1579. This method dispatches a single request and returns the response
  1580. received.  Arguments are the same as for request() described above.
  1581.  
  1582. The difference from request() is that simple_request() will not try to
  1583. handle redirects or authentication responses.  The request() method
  1584. will in fact invoke this method for each simple request it sends.
  1585.  
  1586. =item $ua->is_protocol_supported( $scheme )
  1587.  
  1588. You can use this method to test whether this user agent object supports the
  1589. specified C<scheme>.  (The C<scheme> might be a string (like 'http' or
  1590. 'ftp') or it might be an URI object reference.)
  1591.  
  1592. Whether a scheme is supported, is determined by the user agent's
  1593. C<protocols_allowed> or C<protocols_forbidden> lists (if any), and by
  1594. the capabilities of LWP.  I.e., this will return TRUE only if LWP
  1595. supports this protocol I<and> it's permitted for this particular
  1596. object.
  1597.  
  1598. =back
  1599.  
  1600. =head2 Callback methods
  1601.  
  1602. The following methods will be invoked as requests are processed. These
  1603. methods are documented here because subclasses of C<LWP::UserAgent>
  1604. might want to override their behaviour.
  1605.  
  1606. =over
  1607.  
  1608. =item $ua->prepare_request( $request )
  1609.  
  1610. This method is invoked by simple_request().  Its task is to modify the
  1611. given $request object by setting up various headers based on the
  1612. attributes of the user agent. The return value should normally be the
  1613. $request object passed in.  If a different request object is returned
  1614. it will be the one actually processed.
  1615.  
  1616. The headers affected by the base implementation are; "User-Agent",
  1617. "From", "Range" and "Cookie".
  1618.  
  1619. =item $ua->redirect_ok( $prospective_request, $response )
  1620.  
  1621. This method is called by request() before it tries to follow a
  1622. redirection to the request in $response.  This should return a TRUE
  1623. value if this redirection is permissible.  The $prospective_request
  1624. will be the request to be sent if this method returns TRUE.
  1625.  
  1626. The base implementation will return FALSE unless the method
  1627. is in the object's C<requests_redirectable> list,
  1628. FALSE if the proposed redirection is to a "file://..."
  1629. URL, and TRUE otherwise.
  1630.  
  1631. =item $ua->get_basic_credentials( $realm, $uri, $isproxy )
  1632.  
  1633. This is called by request() to retrieve credentials for documents
  1634. protected by Basic or Digest Authentication.  The arguments passed in
  1635. is the $realm provided by the server, the $uri requested and a boolean
  1636. flag to indicate if this is authentication against a proxy server.
  1637.  
  1638. The method should return a username and password.  It should return an
  1639. empty list to abort the authentication resolution attempt.  Subclasses
  1640. can override this method to prompt the user for the information. An
  1641. example of this can be found in C<lwp-request> program distributed
  1642. with this library.
  1643.  
  1644. The base implementation simply checks a set of pre-stored member
  1645. variables, set up with the credentials() method.
  1646.  
  1647. =item $ua->progress( $status, $request_or_response )
  1648.  
  1649. This is called frequently as the response is received regardless of
  1650. how the content is processed.  The method is called with $status
  1651. "begin" at the start of processing the request and with $state "end"
  1652. before the request method returns.  In between these $status will be
  1653. the fraction of the response currently received or the string "tick"
  1654. if the fraction can't be calculated.
  1655.  
  1656. When $status is "begin" the second argument is the request object,
  1657. otherwise it is the response object.
  1658.  
  1659. =back
  1660.  
  1661. =head1 SEE ALSO
  1662.  
  1663. See L<LWP> for a complete overview of libwww-perl5.  See L<lwpcook>
  1664. and the scripts F<lwp-request> and F<lwp-download> for examples of
  1665. usage.
  1666.  
  1667. See L<HTTP::Request> and L<HTTP::Response> for a description of the
  1668. message objects dispatched and received.  See L<HTTP::Request::Common>
  1669. and L<HTML::Form> for other ways to build request objects.
  1670.  
  1671. See L<WWW::Mechanize> and L<WWW::Search> for examples of more
  1672. specialized user agents based on C<LWP::UserAgent>.
  1673.  
  1674. =head1 COPYRIGHT
  1675.  
  1676. Copyright 1995-2009 Gisle Aas.
  1677.  
  1678. This library is free software; you can redistribute it and/or
  1679. modify it under the same terms as Perl itself.
  1680.